********************************************************************************
* Copyright (c) 2013, Intel Corporation.
*
* This software is furnished under license and may only be
* used or copied in accordance with the terms of that license. No license, 
* express or implied, by estoppel or otherwise, to any intellectual
* property rights is granted by this document. The Software is subject to
* change without notice, and should not be construed as a commitment by
* Intel Corporation to market, license, sell or support any product or
* technology. Unless otherwise provided for in the license under which this
* Software is provided, the Software is provided AS IS, with no warranties
* of any kind, express or implied. 
* Except as expressly permitted by the Software license, neither Intel 
* Corporation nor its suppliers assumes any responsibility or liability for
* any errors or inaccuracies that may appear herein. Except as expressly
* permitted by the Software license, no part of the Software may be
* reproduced, stored in a retrieval system, transmitted in any form, or 
* distributed by any means without the express written consent of Intel 
* Corporation.
*
********************************************************************************

********************************************************************************
* TABLE OF CONTENTS
********************************************************************************
1. Overview
2. Revision Information
3. Install/Uninstall Instructions 
4. Registry Parameters
5. Supported Languages
6. Known Issues


********************************************************************************
* 1.  OVERVIEW
********************************************************************************
This file provides information on how to install the Intel(R) Rapid Start
Technology software package.  

Note:  This readme.txt file is applicable to the installer package as a whole 
and is not specific to a given component of the software.  See the associated 
readme.txt files of the individual components for information specific to that 
component (not all compenents provide an associated readme.txt file.)


********************************************************************************
* 2.  REVISION INFORMATION
********************************************************************************

[3.0.0.1031]
New Features: 
	- Now perform period checks to see if SW disk encryption is enabled and
          prompt user to opt in to continue to use FFS if SW encryption is
	  enabled.  If user selects not to opt in, FFS will be disabled.
Bugfixes:
        - 
Other:
	- 

[3.0.0.1011]
New Features: 
	- Now delay setting the power policies and starting the screen capture
          program by 10s to increase boot responsiveness.
Bugfixes:
        - 
Other:
	- 

[3.0.0.1010]
New Features: 
	- Added SkipRestoreSettingOnExit registry for GUI, default is 0. 
          For customers have modified BIOS to have the GUI settings written
          to BIOS NVRAM in runtime. If SkipRestoreSettingOnExit set to 1, GUI would skip 
          restoring BIOS settings on exit.
Bugfixes:
        - 
Other:
	- 

[3.0.0.1008]
New Features: 
	- 
Bugfixes:
        - Added code to prevent re-use of old capture buffer if call to get new
          buffer fails.  (No known issue.)
Other:
	- 


[3.0.0.1007]
New Features: 
	- Corrected the lockscreen brightness to compensate for the overlay
          the OS applies to the image.
Bugfixes:
        - Compensated for a perceived shift in the lockscreen between the
          captured image and the OS-displayed image.
Other:
	- 


[3.0.0.1006]
New Features: 
	- Fixed issue where the wallpaper would not be displayed upon resume if
          the display had been disabled and then re-enabled before entry to the
          sleep state.
        - Now display the Windows 8 "lockscreen" for the screen capture when
          password protection is enabled.
Bugfixes:
        - 
Other:
	- Moved to VS2012
	- Capture program now built as 32 and 64-bit executables


[3.0.0.1002]
New Features: 
	- Removed the EnableScreenCapture option
Bugfixes:
        - Fixed issue where an exception could occur during OOBE installs.
Other:
	-

[[2.5.0.1014]
New Features: 
	- Include new 2.5 features to display the desktop/wallpaper upon resume.
	- Moved control of the power options overridden by the GUI to the service.
Bugfixes:
        - Included "{}" around the PID GUID in the installer CFG file.
        - Now restore the original BIOS settings on application exit.
Other:
	-

[2.1.0.1007]
New Features: 
	- GUI localization to support total 33 additional languages, include Arabic,Bulgarian,Czech,Danish,
	  German,Greek,Spanish,Estonian,Finnish,French (France),French (Canada),Hebrew,Croatian,Hungarian,
	  Italian,Japanese,Korean,Lithuanian,Latvian,Dutch,Norwegian,Polish,Portuguese (Portugal),Portuguese (Brazail),
	  Romanian,Russian,Slovenian,Serbian (Latin),Swedish,Thai,Turkish,Chinese (PRC),Chinese (Taiwan)
Bugfixes:
	- Fixed issue where the tray icon indicated Intel(R) Rapid Start
          Technology was enabled even when it was turned off when DisableCriticalBatteryWakeControl was
          set in the registry.
Other:
	-


[2.1.0.1002]
New Features: 
	- Changed revision numbering to match "feature set."
	- Update MUP support to Version 2.3.
	- Included WHQL'd drivers for Windows 7 and 8.
Bugfixes:
	- Fixed issue were requirement warning for .NET 3.5 is shown when 
          installing under Windows 8.
Other:
	-

[1.0.0.1042]
New Features: 
	- 
Bugfixes:
	- Fixed issue where the license text files were distributed as UTF-8
          format instead of Unicode frormat.
Other:
	-


[1.0.0.1031]
New Features: 
	- Updated INF's to only allow install on Windows 7 and later OSes.
Bugfixes:
	- 
Other:
	-


[1.0.0.1028]
New Features: 
	- Now allow opening the UI from the start menu or the tray without 
          showing the message that an instance is already running which directed 
          the user to the tray icon to start the UI.
	- Removed 10s delay on showing the icon in the task tray.  (The process
          now waits for explorer.exe and winlogon.exe presence to populate the
          tray.)
Bugfixes:
	- Fixed display of the About box and UI when the display is set for
          125% and 150% of normal.
	- Resolved an issue where the tray icon is not seen during first boot
          after an OOBE install.
Other:
	-


[1.0.0.1024]
New Features: 
	-
Bugfixes:
	- Now remove task from Task Scheduler during uninstall.
	- GUI will check Task scheduler entry and update it, if it is older one.

Other:
	-

[1.0.0.1023]
New Features: 
	-
Bugfixes:
	- Fixed the application crash on non-adminstrative account.
	- Updated the message to run the utility in administrative account.
	- Changed the scheduled task for the UI to use the "Administrators"
          accounts, so it will run in all administrators.  Other must start
          UI manually if needed and run as an administrator.
	- Removed scheduled task from Task Scheduler during installation
Other:
	-

[1.0.0.1022]
New Features:
	- 
Bugfixes:
	- Changed to move all files to a temporary directory to fix the case 
          that the installer is run from a CD.
Other:
	- 


[1.0.0.1021]
New Features:
	- 
Bugfixes:
	- Resolved translation issue in Japanese, S.Chinese, Danish, Finnish, 
	  Korean and Portuguese (Brazil).
Other:
	- 

[1.0.0.1020]
New Features:
	- 
Bugfixes:
	- Now use the directory of the executable for the current directory; 
          instead of the current working directory.  This resolves and issue
          where file cannot be found if you run the program from a directory 
          other than the one it is located in.
Other:
	- 

[1.0.0.1019]
New Features:
	- Included "upgradecode" code in MUP.XML.
Bugfixes:
	- Fixed an issue with Rapid Start user interface requiring restart after 
	  first time configuration updates.
Other:
	- 

[1.0.0.1018]
New Features:
	- 
Bugfixes:
	-
Other:
	- Updated setup wrapper revision number


[1.0.0.1017]
New Features:
	- The installer will now check the PCH ID and will not allow 
          installation on desktop Huron River platforms.
Bugfixes:
	- 
Other:
	- 

[1.0.0.1016]
New Features:
	- 
Bugfixes:
	- Changed the strings displayed in the GUI for Chinese.  (Text read to
          turn on/off lights, now reads to turn on/off function.)
Other:
	- 


[1.0.0.1015]
New Features:
	- GUI localization to support six additional languages (Arabic, Danish, 
          Finnish, Portuguese (Brazil), Russian, and Swedish)
Bugfixes:
	- 
Other:
	- 


[1.0.0.1014]
New Features:
	- 
Bugfixes:
	- Changed to use "(R)" in the installer script as the symbol is not
          accepted in some languages (Chinese and Korean are known cases.)
Other:
	- 


[1.0.0.1013]
New Features:
	- Localization to support eight languages (Italian, Japanese, Korean, 
	  French, German, Chinese-PRC, Chinese-Taiwan, and  Spanish.)
	- Added the ability to allow to run the GUI in "invisible" mode based on 
          a registry key (InvisibleMode). Default (0) is "visible" mode. 
	- If the GUI is running in "invisible" mode, the application will
	  show/hide message prompts based on a registry key
	  (HideMessagePrompts). Default (0) is to display message prompts.
	- Added support to allow the user to disable the critical battery 
	  control based on a registry key (DisableCriticalBatteryWakeControl). 
	  Default (0) is critical battery wake controls enabled.
Bugfixes:
	- Re-attempting driver access and immediately release the handle after 
	  use to void contention with other apps/services.
Other:
	- 


[1.0.0.1012]
New Features:
	- Installer and associated files updated to V1.3.4.
	- Updated GUI to 1.0.0.1005
Bugfixes:
	- No longer attempt redundant removal of service in installer
          configuration file.
        - Now removes the driver registry key during uninstall.
Other:
	- 


[1.0.0.1010]
New Features:
	- Service now verifies enabling status prior to flushing pages
Bugfixes:
	- 
Other:
	- 


[1.0.0.1009]
New Features:
	- Added GUI configuration interface
Bugfixes:
	- 
Other:
	- 


[1.0.0.1008]
New Features:
	- Drivers signed by Microsoft after WHQL
        - Disabled Active Page Flushes on S3 entry by default
        - Changed to the PV language pack
Bugfixes:
	- 
Other:
	- 


********************************************************************************
* 3. INSTALL/UNINSTALL INSTRUCTIONS
********************************************************************************

3.1 Interactive Installation

    Run the installation program Setup.exe in administrator mode. 

    1.  Select the Setup.exe application
    2.  Right-click over Setup.exe and select "Run as Administrator.

    The program automatically installs the software onto the target
system, prompting the user for input as needed.


3.2 Silent Installation

    Run "Setup.exe -s" from the command line in administrator mode.
    
    1.  Click on the "Start" button/Windows button in the taskbar.
    2.  Click on "All Programs."
    3.  Click on "Accessories."
    4.  Right-click over "Command Prompt" and select "Run as Administrator.
    5.  Navigate to the folder where Setup.exe resides.
    6.  Run "Setup.exe -s" to silently install the software.


3.3 Uninstalling the Software

    The software may be uninstalled through the Control Panel using the
"Program and Features" applet

    1.  Click on the "Start" button/Windows button in the taskbar.
    2.  Click on "Control Panel."
    3.  In the Control Panel, click on the link to "Uninstall a program."
    4.  Double-click the "Intel(R) Rapid Start Technology" item
    5.  Follow the prompts to uninstall the software
    6.  Reboot may be required

3.4 Customization

    Some features may be enabled/disabled based on registry settings.  The
    default settings are specified in the setup.if2 file.  The values may
    be changed in this file prior to installation to customize behavior.
    The registry items are indicated by "[Registry]".  To change the default
    value during installation, change the associated "data" item for the
    required registry value.  The allowed values depend on the individual
    feature. (For binary items, valid values are 0 and 1.)



********************************************************************************
* 4. REGISTRY PARAMETERS
********************************************************************************

4.1 User Interface Registry Parameters

    Note:  Not all registry parameters are documented.  Only those items which
           are expected to be used by manufacturers are detailed here.

4.1.1 Configuration Application Registry Parameters

    Interface registry parameters for 32-bit systems are located in the 
    registry at:

	HKLM\SOFTWARE\Intel\irstrt\Parameters

    For 64-bit systems at:

        HKLM\Software\Wow6432Node\Intel\irstrt\Parameters

    InvisibleMode - Allows the user to run the GUI in "invisible" mode.
		    Default (0) is "visible" mode.

    HideMessagePrompts - Allows the user to control display of user interface
		         message prompts when running in "invisible" mode.   
                         Default (0) is to display message prompts.

    DisableCriticalBatteryWakeControl - Allows the user to disable the critical 
		                        battery control. Default (0) is critical
                                        battery wake controls are enabled.
    
    MaxTimer - Rapid start maximum timer value displayed on the GUI knob. 
	       This can be changed by manufacturers if they want to change the 
               default max timer value (120 minutes)

    
    MinTimer - Rapid start minimum timer value displayed on the GUI knob. 
	       This can be changed by manufacturers if they want to change the 
               default min timer value (0 minutes)

    SkipRestoreSettingOnExit - If set, the application will not restore the
                               settings in BIOS back to the boot values.  Allows
		               customers to save settings from GUI back to NVRAM
                               and keep those setting in sync with the user values.
                               Default (0) is to restore BIOS settings back to the
                               values that were seen at boot when the GUI exits.

4.1.2 Service Registry Parameters

    Service parameters are located in the registry at:

	HKLM\CurrentControlSet\Services\irstrtsv\Parameters

    EnableOSHybridSleepUpdate - Allows the user to enable Hybrid Sleep 
                                (Active Page Flush) with Rapid Start. Default(0) 
                                is not to force use of the Hybrid Sleep feature.

    DisableOSS4TimerOverride - Disables overriding of the OS S4 timer when
                               RTC wake is enabled.
                               Default(0) is to disable the OS S4 timer.

    EnableSWEncryptionCheck - If enabled, fixed disks in the system will be checked
                              for software encryption.  If software encryption is
                              found, the user will be prompted to opt in to 
                              continue using FFS.  Default (1) is enabled.

    SwEncryptionCheckPeriod - Specifis how often periodic checks are performed to
                              determine if sotware encryption is enabled. Default
                              5 minutes.  Values valid from 0 (disabled) to 
                              71,582 minutes.)

********************************************************************************
* 5. Supported Languages
********************************************************************************

The installation program has been localized to support the following
languages:

    Arabic (0401)
    Czech (0405)
    Danish (0406)
    German (0407)
    Greek (0408)
    English-US (0409)
    Spanish (0C0A)
    Finnish (040B)
    French (040C)
    Hebrew (040D)
    Hungarian (040E)
    Italian (0410)
    Japanese (0411)
    Korean (0412)
    Norwegian (0414)
    Dutch (0413)
    Polish (0415)
    Portuguese-Brazil (0416)
    Portuguese-Portugal (0816)
    Romanian (0418)
    Russian (0419)
    Slovak (041B)
    Slovenian (0424)
    Swedish (041D)
    Thai (041E)
    Turkish (041F)
    Chinese-PRC (0804)
    Chinese-Taiwan (0404)

The user interface program has been localized to support the following
languages:
    Arabic (0401)
    Bulgarian (0402)
    Czech (0405)
    Danish (0406)
    German (0407)
    Greek (0408)
    English-US (0409)
    Spanish (0C0A)
    Estonian (0425)
    Finnish (040B)
    French (France) (040C)
    French (Canada) (0C0C)
    Hebrew (040D)
    Croatian (041A)
    Hungarian (040E)
    Italian (0410)
    Japanese (0411)
    Korean (0412)
    Lithuanian (0427)
    Latvian (0426)
    Dutch (0413)
    Norwegian (0414)
    Polish (0415)
    Portuguese (Portugal) (0816)
    Portuguese (Brazil) (0416)
    Romanian (0418)
    Russian (0419)
    Slovenian (0424)
    Serbian (Latin) (081A)
    Swedish (041D)
    Thai (041E)
    Turkish (041F)
    Chinese (PRC) (0804)
    Chinese (Taiwan) (0404)

********************************************************************************
* 6. KNOWN ISSUES
********************************************************************************

    1.  If a user switches from the first account logged into, to a different
        user account without logging off, the security dialog for software disk 
        encryption may not be displayed in the follow cases:  The user enables 
        Intel® Rapid Start Technology through the UI or disk encryption is 
        enabled/initiated in the second user account while Intel® Rapid Start 
        Technology is enabled.  This may result in Intel® Rapid Start Technology      
        remaining enabled on a system with software-encrypted disks.
    2.  Intel® Rapid Start Technology may be disabled during installation on 
        systems with software-encrypted disks present.  This will require the 
        user to re-enable FFS through the configuration manager.
